AssureID Connect Web Service
| Get | /AssureTec.AssureID.Web/AssureIDService/Document/{INSTANCEID}/Image/Metrics |
Uri: http://localhost/AssureTec.AssureID.Web/AssureIDService/Document/{INSTANCEID}/Image/Metrics?side={SIDE}&light;={LIGHT}
Description
Retrieve metrics for a specific image that was previously posted to a document.
Parameters
| Name | Description | Data Type |
|---|---|---|
| INSTANCEID | Guid document identifier of the document from which the document image should be returned. | String |
| SIDE | DocumentSide enumeration which identifies the document side of the image. | String |
| LIGHT | LightSource enumeration which identifies the light source of the image. | String |
Response (Xml)
The response body is of type http://services.assureid.net/2014/09:DocumentImage.
Sample Data
<DocumentImage xmlns="http://services.assureid.net/2014/09"> <GlareMetric>255</GlareMetric> <HorizontalResolution>2147483647</HorizontalResolution> <Id>1627aea5-8e0a-4371-9022-9b504344e724</Id> <IsCropped>true</IsCropped> <IsTampered>true</IsTampered> <Light>White</Light> <MimeType>String content</MimeType> <SharpnessMetric>255</SharpnessMetric> <Side>Front</Side> <Uri>http://www.example.com/</Uri> <VerticalResolution>2147483647</VerticalResolution> </DocumentImage>
Response (Json)
Sample Data
{
"GlareMetric": 255,
"HorizontalResolution": 2147483647,
"Id": "1627aea5-8e0a-4371-9022-9b504344e724",
"IsCropped": true,
"IsTampered": true,
"Light": 0,
"MimeType": "String content",
"SharpnessMetric": 255,
"Side": 0,
"Uri": "http://www.example.com/",
"VerticalResolution": 2147483647
}Remarks
Returns all of the metadata associated with the specified document image, including any optional imaging metrics. (Note, imaging metrics are only available for LightSource.White images, and only if they were calculated when the image was originally posted.) Metrics, if available, are returned as an integer value between 0 and 100.
See Also